﻿// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

using System;
using System.Collections.Generic;

namespace ICSharpCode.Profiler.Controller.Data
{
	/// <summary>
	/// Used to write profiling data to a format (e. g. SQLite DB, binary).
	/// Instance members of this interface are not thread-safe.
	/// </summary>
	public interface IProfilingDataWriter
	{
		/// <summary>
		/// Writes an unmanaged dataset.
		/// </summary>
		/// <param name="dataSet">The data set to write.</param>
		void WriteDataSet(IProfilingDataSet dataSet);
		
		/// <summary>
		/// Writes an amount of name mappings.
		/// </summary>
		void WriteMappings(IEnumerable<NameMapping> mappings);
		
		/// <summary>
		/// Writes an amount of performance counters and the collected values.
		/// </summary>
		void WritePerformanceCounterData(IEnumerable<PerformanceCounterDescriptor> counters);
		
		/// <summary>
		/// Writes an amount of events.
		/// </summary>
		void WriteEventData(IEnumerable<EventDataEntry> events);
		
		/// <summary>
		/// Closes and disposes the underlying data structure.
		/// </summary>
		void Close();
		
		/// <summary>
		/// The processor speed read from the registry of the computer where the profiling session was created on.
		/// The processor frequency is measured in MHz.
		/// </summary>
		int ProcessorFrequency { get; set; }
		
		/// <summary>
		/// Gets the number of datasets that have been written by this IProfilingDataWriter.
		/// </summary>
		int DataSetCount { get; }
	}
}
